Appliance LocalAccounts Info

Appliance LocalAccounts Info
Appliance LocalAccounts Info

The Appliance LocalAccounts Info schema defines the local account properties.

This schema was added in vSphere API 6.7.

JSON Example
{
    "fullname": "string",
    "email": "string",
    "roles": [
        "string"
    ],
    "enabled": false,
    "has_password": false,
    "last_password_change": "string",
    "password_expires_at": "string",
    "inactive_at": "string",
    "min_days_between_password_change": 0,
    "max_days_between_password_change": 0,
    "warn_days_before_password_expiration": 0
}
string
fullname
Optional

Full name of the user

This property was added in vSphere API 6.7.

If missing or null, the value was never set.

string
email
Optional

Email address of the local account

This property was added in vSphere API 6.7.

If missing or null, the value was never set.

array of string
roles
Required

User roles

This property was added in vSphere API 6.7.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.appliance.roles. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.appliance.roles.

boolean
enabled
Required

Flag indicating if the account is enabled

This property was added in vSphere API 6.7.

boolean
has_password
Required

Is the user password set.

This property was added in vSphere API 6.7.

string As date-time As date-time
last_password_change
Optional

Date and time password was changed.

This property was added in vSphere API 6.7.

If missing or null, the password was never set.

string As date-time As date-time
password_expires_at
Optional

Date when the account's password will expire

This property was added in vSphere API 6.7.

If missing or null, the password never expires.

string As date-time As date-time
inactive_at
Optional

Date and time account will be locked after password expiration.

This property was added in vSphere API 6.7.

If missing or null, account will not be locked.

integer As int64 As int64
min_days_between_password_change
Optional

Minimum number of days between password change

This property was added in vSphere API 6.7.

If missing or null, pasword can be changed any time.

integer As int64 As int64
max_days_between_password_change
Optional

Maximum number of days between password change

This property was added in vSphere API 6.7.

If missing or null, password never expires.

integer As int64 As int64
warn_days_before_password_expiration
Optional

Number of days of warning before password expires

This property was added in vSphere API 6.7.

If missing or null, a user is never warned.

Returned By